Update a Stop

SecurityAuthToken

Request

path Parameters

shipmentId required	string <uuid> The id of the shipment
stopId required	string <uuid> The id of the stop

header Parameters

X-Company-Id

string

allows request to retrieve information about the company given in the header instead of the company associated with the requesting user

Request Body schema: application/json
required

	Array of objects (Accessorial)
	Array of objects (StopAlert)
appointment_needed	boolean
	object (AppointmentType)
	object (StopAppointmentWindow) Stop Appointment Window Information
	object (ETAWindow)
confirmed_arrival_at	string or null <date-time> Optional of when the driver first arrived at the Stop
confirmed_departure_at	string or null <date-time> Optional of when the Stop was departed
created_at	string or null <date-time>
	object (StopCustomData) Custom data for Stop
display_eta_window	string or null
display_planned_window	string or null
display_schedule	string or null
eta_overridden_by	string or null <uuid> ID of user who marked ETA as overridden, if exists
id required	string <uuid>
instructions	string or null
internal_notes	string or null
is_completed	boolean Whether or not the Stop was completed
is_dropoff required	boolean
is_pickup required	boolean
required	object (StopLocation)
ordinal_index required	integer <int32>
planned_date	string or null Planned date of the stop, in string of the form YYYY-MM-DD
planned_time_window_end	string or null <time>
planned_time_window_start	string or null <time>
	object (StopPlanningWindow) Stop Planning Window Information. This is intended to replace the `planned_date`, `planned_time_window_start`, and `planned_time_window_end` fields.
	object (ETAWindow)
sequence_number	integer <int32>
status	string or null Enum: "AT_STOP" "CANCELLED" "DEPARTED" "EN_ROUTE"
status_reason_code	string or null Enum: "ACCIDENT" "ADDRESS_CORRECTED_DELIVERY_ATTEMPTED" "ALTERNATE_CARRIER_DELIVERED" "ALTERNATE_CARRIER_PICKED_UP" "AWAITING_EXPORT" "AWAITING_IMPORT" "BORDER_CLEARANCE" "CARRIER_DISPATCH_ERROR" "CARRIER_KEYING_ERROR" "CARRIER_RELATED" "CARTAGE_AGENT" "CASH_NOT_AVAILABLE_FROM_CONSIGNEE" "CIVIL_EVENT" "COLLECT_ON_DELIVERY_REQUIRED" "CONSIGNEE_CLOSED" "CONSIGNEE_RELATED" "CONTAMINATED" "CREDIT_HOLD" "CUSTOMER_REQUESTED_DIFFERENT_DELIVERY_WINDOW" "CUSTOMER_REQUESTED_FUTURE_DELIVERY" "CUSTOMER_STRIKE" "CUSTOMER_VACATION" "CUSTOMER_WANTED_EARLIER_DELIVERY" "CUSTOMS_DOCUMENTATION_PROBLEM" "DAMAGED" "DELIVERY_SHORTAGE" "DRIVER_NOT_AVAILABLE" "DRIVER_RELATED" "EQUIPMENT_SHORTAGE" "EQUIPMENT_VOLUME_NOT_AVAILABLE" "EXCEEDS_SERVICE_LIMITATIONS" "FAILED_TO_RELEASE_BILLING" "FLATCAR_SHORTAGE" "HELD_FOR_CONSIGNEE" "HELD_FOR_FULL_CARRIER_LOAD" "HELD_FOR_PAYMENT" "HELD_FOR_PROTECTIVE_SERVICE" "HELD_PENDING_APPOINTMENT" "HELD_PER_SHIPPER" "HOLIDAY_CLOSED" "HOURS_OF_SERVICE_LIMIT" "IMPROPER_FACILITY_OR_EQUIPMENT" "IMPROPER_INTERNATIONAL_PAPERWORK" "IMPROPER_TEMPERATURE" "INCONSISTENT_WEIGHT" "INCORRECT_ADDRESS" "INDIRECT_DELIVERY" "INSUFFICIENT_DELIVERY_TIME" "INSUFFICIENT_PICKUP_TIME" "INSUFFICIENT_TRAVEL_TIME_DETECTED" "INTERNATIONAL_NON_CARRIER_DELAY" "LATE_TENDER_DISPATCH" "LOCATION_CHANGE" "LOAD_SHIFTED" "MECHANICAL_BREAKDOWN" "MIS_SORT" "MISSED_DELIVERY" "MISSED_PICK-UP" "MISSING_DOCUMENTS" "NON_EXPRESS_CLEARANCE_DELAY" "NORMAL_APPOINTMENT" "NORMAL_STATUS" "NO_APPOINTMENT_SCHEDULED" "NO_REQUESTED_ARRIVAL_DATE_OR_TIME" "NO_REQUESTED_ARRIVAL_TIME_PROVIDED_BY_SHIPPER" "OTHER" "PAST_CUT_OFF_TIME" "PREARRANGED_APPOINTMENT" "PREVIOUS_STOP" "PROCESSING_DELAY" "PRODUCTION_FALLDOWN" "RAILROAD_FAILED_TO_MEET_SCHEDULE" "RECIPIENT_UNAVAILABLE" "RECONSIGNED" "RECEIVING_TIME_RESTRICTED" "REFUSED_BY_CUSTOMER" "RESTRICTED_ARTICLES_UNACCEPTABLE" "RETURNED_TO_SHIPPER" "ROAD_CONDITIONS" "SHIPMENT_OVERWEIGHT" "SHIPPER_RELATED" "SUSPENDED_AT_CUSTOMER_REQUEST" "TRACKING_EVENT_AUTOMATED_CALL" "TRACKING_EVENT_EDI_UPDATE" "TRACKING_EVENT_ELD_UPDATE" "TRACKING_EVENT_GEOFENCE_BREACH" "TRACKING_EVENT_MANUAL_LOCATION_UPDATED" "TRACKING_EVENT_MOBILE_APP" "TRACKING_EVENT_MOBILE_APP_UPDATED_BY_DRIVER" "TRACTOR_CONVENTIONAL_NOT_AVAILABLE" "TRACTOR_WITH_SLEEPER_CAR_NOT_AVAILABLE" "TRAILER_CLASS_NOT_AVAILABLE" "TRAILER_NOT_AVAILABLE" "TRAILER_NOT_USABLE_DUE_TO_PRIOR_PRODUCT" "TRAIN_DERAILMENT" "TRAP_FOR_CUSTOMER" "UNABLE_TO_CONTACT_RECIPIENT" "UNABLE_TO_LOCATE" "UNKNOWN" "WAITING_FOR_CUSTOMER_PICKUP" "WAITING_FOR_CUSTOMER_SPECIFIED_CARRIER" "WAITING_INSPECTION" "WAITING_SHIPPING_INSTRUCTIONS" "WEATHER_OR_NATURAL_DISASTER"
trip_management_eta	string or null <date-time>
trip_management_eta_last_updated	string or null <date-time>
unconfirmed_arrival_at	string or null <date-time> Read-only. Geofence arrival time
unconfirmed_departure_at	string or null <date-time> Read-only. Geofence departure time
updated_at	string or null <date-time>

Responses

200

Successfully updated a Stop

Response Schema: application/json

	Array of objects (Accessorial)
	Array of objects (StopAlert)
appointment_needed	boolean
	object (AppointmentType)
	object (StopAppointmentWindow) Stop Appointment Window Information
	object (ETAWindow)
confirmed_arrival_at	string or null <date-time> Optional of when the driver first arrived at the Stop
confirmed_departure_at	string or null <date-time> Optional of when the Stop was departed
created_at	string or null <date-time>
	object (StopCustomData) Custom data for Stop
display_eta_window	string or null
display_planned_window	string or null
display_schedule	string or null
eta_overridden_by	string or null <uuid> ID of user who marked ETA as overridden, if exists
id required	string <uuid>
instructions	string or null
internal_notes	string or null
is_completed	boolean Whether or not the Stop was completed
is_dropoff required	boolean
is_pickup required	boolean
required	object (StopLocation)
ordinal_index required	integer <int32>
planned_date	string or null Planned date of the stop, in string of the form YYYY-MM-DD
planned_time_window_end	string or null <time>
planned_time_window_start	string or null <time>
	object (StopPlanningWindow) Stop Planning Window Information. This is intended to replace the `planned_date`, `planned_time_window_start`, and `planned_time_window_end` fields.
	object (ETAWindow)
sequence_number	integer <int32>
status	string or null Enum: "AT_STOP" "CANCELLED" "DEPARTED" "EN_ROUTE"
status_reason_code	string or null Enum: "ACCIDENT" "ADDRESS_CORRECTED_DELIVERY_ATTEMPTED" "ALTERNATE_CARRIER_DELIVERED" "ALTERNATE_CARRIER_PICKED_UP" "AWAITING_EXPORT" "AWAITING_IMPORT" "BORDER_CLEARANCE" "CARRIER_DISPATCH_ERROR" "CARRIER_KEYING_ERROR" "CARRIER_RELATED" "CARTAGE_AGENT" "CASH_NOT_AVAILABLE_FROM_CONSIGNEE" "CIVIL_EVENT" "COLLECT_ON_DELIVERY_REQUIRED" "CONSIGNEE_CLOSED" "CONSIGNEE_RELATED" "CONTAMINATED" "CREDIT_HOLD" "CUSTOMER_REQUESTED_DIFFERENT_DELIVERY_WINDOW" "CUSTOMER_REQUESTED_FUTURE_DELIVERY" "CUSTOMER_STRIKE" "CUSTOMER_VACATION" "CUSTOMER_WANTED_EARLIER_DELIVERY" "CUSTOMS_DOCUMENTATION_PROBLEM" "DAMAGED" "DELIVERY_SHORTAGE" "DRIVER_NOT_AVAILABLE" "DRIVER_RELATED" "EQUIPMENT_SHORTAGE" "EQUIPMENT_VOLUME_NOT_AVAILABLE" "EXCEEDS_SERVICE_LIMITATIONS" "FAILED_TO_RELEASE_BILLING" "FLATCAR_SHORTAGE" "HELD_FOR_CONSIGNEE" "HELD_FOR_FULL_CARRIER_LOAD" "HELD_FOR_PAYMENT" "HELD_FOR_PROTECTIVE_SERVICE" "HELD_PENDING_APPOINTMENT" "HELD_PER_SHIPPER" "HOLIDAY_CLOSED" "HOURS_OF_SERVICE_LIMIT" "IMPROPER_FACILITY_OR_EQUIPMENT" "IMPROPER_INTERNATIONAL_PAPERWORK" "IMPROPER_TEMPERATURE" "INCONSISTENT_WEIGHT" "INCORRECT_ADDRESS" "INDIRECT_DELIVERY" "INSUFFICIENT_DELIVERY_TIME" "INSUFFICIENT_PICKUP_TIME" "INSUFFICIENT_TRAVEL_TIME_DETECTED" "INTERNATIONAL_NON_CARRIER_DELAY" "LATE_TENDER_DISPATCH" "LOCATION_CHANGE" "LOAD_SHIFTED" "MECHANICAL_BREAKDOWN" "MIS_SORT" "MISSED_DELIVERY" "MISSED_PICK-UP" "MISSING_DOCUMENTS" "NON_EXPRESS_CLEARANCE_DELAY" "NORMAL_APPOINTMENT" "NORMAL_STATUS" "NO_APPOINTMENT_SCHEDULED" "NO_REQUESTED_ARRIVAL_DATE_OR_TIME" "NO_REQUESTED_ARRIVAL_TIME_PROVIDED_BY_SHIPPER" "OTHER" "PAST_CUT_OFF_TIME" "PREARRANGED_APPOINTMENT" "PREVIOUS_STOP" "PROCESSING_DELAY" "PRODUCTION_FALLDOWN" "RAILROAD_FAILED_TO_MEET_SCHEDULE" "RECIPIENT_UNAVAILABLE" "RECONSIGNED" "RECEIVING_TIME_RESTRICTED" "REFUSED_BY_CUSTOMER" "RESTRICTED_ARTICLES_UNACCEPTABLE" "RETURNED_TO_SHIPPER" "ROAD_CONDITIONS" "SHIPMENT_OVERWEIGHT" "SHIPPER_RELATED" "SUSPENDED_AT_CUSTOMER_REQUEST" "TRACKING_EVENT_AUTOMATED_CALL" "TRACKING_EVENT_EDI_UPDATE" "TRACKING_EVENT_ELD_UPDATE" "TRACKING_EVENT_GEOFENCE_BREACH" "TRACKING_EVENT_MANUAL_LOCATION_UPDATED" "TRACKING_EVENT_MOBILE_APP" "TRACKING_EVENT_MOBILE_APP_UPDATED_BY_DRIVER" "TRACTOR_CONVENTIONAL_NOT_AVAILABLE" "TRACTOR_WITH_SLEEPER_CAR_NOT_AVAILABLE" "TRAILER_CLASS_NOT_AVAILABLE" "TRAILER_NOT_AVAILABLE" "TRAILER_NOT_USABLE_DUE_TO_PRIOR_PRODUCT" "TRAIN_DERAILMENT" "TRAP_FOR_CUSTOMER" "UNABLE_TO_CONTACT_RECIPIENT" "UNABLE_TO_LOCATE" "UNKNOWN" "WAITING_FOR_CUSTOMER_PICKUP" "WAITING_FOR_CUSTOMER_SPECIFIED_CARRIER" "WAITING_INSPECTION" "WAITING_SHIPPING_INSTRUCTIONS" "WEATHER_OR_NATURAL_DISASTER"
trip_management_eta	string or null <date-time>
trip_management_eta_last_updated	string or null <date-time>
unconfirmed_arrival_at	string or null <date-time> Read-only. Geofence arrival time
unconfirmed_departure_at	string or null <date-time> Read-only. Geofence departure time
updated_at	string or null <date-time>

default

Default error response

put/shipments/{shipmentId}/stops/{stopId}/

Request samples

application/json

{"accessorials": [{"code": "string",
"currency_unit": "string",
"description": "string",
"id": 0,
"is_charge_code": true,
"long_description": "string",
"price": 0.1,
"type": "string"
}
],
"alerts": [{"alert_type": "AT_RISK",
"created_at": "2019-08-24T14:15:22Z",
"created_by_driver": "4b7764ea-906e-4a4e-9227-7c0083c9979c",
"created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
"description": "string",
"expiration": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"location": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"occurred_at": "2019-08-24T14:15:22Z",
"reason_code": "ACCIDENT",
"stop": "0bfa2243-0f07-4994-a5a2-d14bef007f26",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"appointment_needed": true,
"appointment_type": {"code": "string",
"id": 0,
"name": "string"
},
"appointment_window": {"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"carrier_specified_eta": {"created_at": "2019-08-24T14:15:22Z",
"initial_window_end": "2019-08-24T14:15:22Z",
"initial_window_start": "2019-08-24T14:15:22Z",
"running_window_end": "2019-08-24T14:15:22Z",
"running_window_start": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"confirmed_arrival_at": "2019-08-24T14:15:22Z",
"confirmed_departure_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"display_eta_window": "string",
"display_planned_window": "string",
"display_schedule": "string",
"eta_overridden_by": "42d07ec7-3b78-426f-8b1b-ad95f5bf150e",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instructions": "string",
"internal_notes": "string",
"is_completed": true,
"is_dropoff": true,
"is_pickup": true,
"location": {"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"company_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_using_address_book_entry_id": "string",
"dock_external_id": "string",
"facility_id": "string",
"facility_name": "string",
"friday_close_time": "14:15:22Z",
"friday_open_time": "14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identification_code": "string",
"location_name": "string",
"location_type": {"id": 0,
"name": "string"
},
"monday_close_time": "14:15:22Z",
"monday_open_time": "14:15:22Z",
"notes": "string",
"open_friday": true,
"open_monday": true,
"open_saturday": true,
"open_sunday": true,
"open_thursday": true,
"open_tuesday": true,
"open_wednesday": true,
"point_of_contacts": [{"email": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"load_board_enabled": true,
"load_board_invite_last_sent_at": "2019-08-24T14:15:22Z",
"preferences": {"cancellation": true,
"delayed": true,
"delivered": true,
"eta_changed": true,
"picked_up": true,
"receive_bol_on_shipment_booked": true,
"shipment_booked": true,
"trailer_assigned": true
},
"user": "76f62a58-5404-486d-9afc-07bded328704"
}
],
"saturday_close_time": "14:15:22Z",
"saturday_open_time": "14:15:22Z",
"sunday_close_time": "14:15:22Z",
"sunday_open_time": "14:15:22Z",
"thursday_close_time": "14:15:22Z",
"thursday_open_time": "14:15:22Z",
"tuesday_close_time": "14:15:22Z",
"tuesday_open_time": "14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"wednesday_close_time": "14:15:22Z",
"wednesday_open_time": "14:15:22Z"
},
"ordinal_index": 0,
"planned_date": "string",
"planned_time_window_end": "14:15:22Z",
"planned_time_window_start": "14:15:22Z",
"planning_window": {"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"predictive_model_eta": {"created_at": "2019-08-24T14:15:22Z",
"initial_window_end": "2019-08-24T14:15:22Z",
"initial_window_start": "2019-08-24T14:15:22Z",
"running_window_end": "2019-08-24T14:15:22Z",
"running_window_start": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence_number": 0,
"status": "AT_STOP",
"status_reason_code": "ACCIDENT",
"trip_management_eta": "2019-08-24T14:15:22Z",
"trip_management_eta_last_updated": "2019-08-24T14:15:22Z",
"unconfirmed_arrival_at": "2019-08-24T14:15:22Z",
"unconfirmed_departure_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Response samples

200
default